home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / bgtop20.zip / BGTOP.DOC next >
Text File  |  1991-08-22  |  10KB  |  213 lines
  1.  
  2.               VOICE               B.J. GUILLOT               MODEM
  3.          (713) 893-9123       2611 RUSHWOOD CIRCLE      (713) 893-9124
  4.                             HOUSTON TEXAS 77067-1941
  5.  
  6.             Copyright B.J. Guillot 1989-1991.  All Rights Reserved.
  7.  
  8.          =============================================================
  9.          BGTOP 2.0                                           22 AUG 91
  10.          =============================================================
  11.  
  12.          -------------------------------------------------------------
  13.          ABSTRACT
  14.          -------------------------------------------------------------
  15.  
  16.          BGTOP creates an informative bulletin  for  your  system that
  17.          includes  the  top  users  in  terms of calls,  uploads,  and
  18.          downloads.  BGTOP may alternatively be run as a logon door.
  19.  
  20.          This  document is written  on  a level so that anyone running
  21.          a  GT Power  bulletin board  can  understand it.  Experienced
  22.          users will no doubt find the instructions quite elementary.
  23.  
  24.          -------------------------------------------------------------
  25.          EXECUTION
  26.          -------------------------------------------------------------
  27.  
  28.          Before begining with this tutorial on the operation of BGTOP,
  29.          please be sure to have your GTPATH environment variable  set.
  30.          If  you  do  not,  please add the following directive to your
  31.          AUTOEXEC.BAT file and  reboot  your system.   Please remember
  32.          that the  GTPATH  is  intended to point towards your main  GT
  33.          directory  and the path does not necessarily have to be named
  34.          the same path as shown in this example.
  35.  
  36.             set gtpath=c:\gt
  37.  
  38.          Using this companion program is  quite  easy.  If you wish to
  39.          ignore the optional parameters,  you may run BGTOP by feeding
  40.          it only one command line parameter--a bulletin number--e.g.
  41.  
  42.             bgtop 4
  43.  
  44.          In the above example,  BGTOP  would create a file named 4 and
  45.          4.CBS in the  default  download  (bulletins)  directory.  The
  46.          colors used in the ANSI (CBS) version of the report are taken
  47.          directly from the sysop selected color codes in GT.CNF.
  48.  
  49.          Be careful as BGTOP will overwrite any existing bulletin.
  50.  
  51.          The actual BGTOP.EXE file may be placed in any directory.
  52.  
  53.          BGTOP offers several options for the  advanced  user.  Please
  54.          note the following available command line parameters.
  55.  
  56.             bgtop bulletin|door [/ln:number] [/ex:access_levels] [/nf]
  57.  
  58.          -------------------------------------------------------------
  59.          DOOR MODE
  60.          -------------------------------------------------------------
  61.  
  62.          If you wish to run BGTOP as a dreaded logon door(tm), specify
  63.          the 'door' option rather than a bulletin number, e.g.
  64.  
  65.             bgtop door
  66.  
  67.          A number of things occur during  door mode that you should be
  68.          aware of.   BGTOP writes to the CON device and its output can
  69.          be redirected easily by the  DOS CTTY  command or the greater
  70.          than sign.  Observe these three example GTLOGON.BAT files.
  71.  
  72.             @echo off          @echo off                 @echo off
  73.             ctty com1          bgtop door > com1         %1 com1
  74.             bgtop door                                   bgtop door
  75.             ctty con                                     %1 con
  76.  
  77.          All three of the above files perform the  same  function. The
  78.          third example  shows  the  optimum batch file because it uses
  79.          GT to determine whether to redirect output to the com port.
  80.  
  81.          If you  use  a  com port  other than  COM1,  you will need to
  82.          change the batch file accordingly.
  83.  
  84.          A  great disadvantage exists,  however,  when  one  redirects
  85.          output directly to a com port or auxillary device--the  sysop
  86.          can not see what the user sees.  This problem can be overcome
  87.          by using the GATEWAY device driver available on many bulletin
  88.          board systems.  GATEWAY  can be easily installed by placing a
  89.          one line command in the CONFIG.SYS file.
  90.  
  91.             device=c:\util\gateway2.sys -d -1
  92.  
  93.          If you are using a com port other than COM1, you will need to
  94.          change the  '1'  to  whichever com port number you are using.
  95.          Here,  again,  are the three batch files,  however, they have
  96.          been slightly modified to take advantage of GATEWAY.
  97.  
  98.             @echo off          @echo off                 @echo off
  99.             ctty gate1         bgtop door > gate1        %1 gate1
  100.             bgtop door                                   bgtop door
  101.             ctty con                                     %1 con
  102.  
  103.          If  you  use  a  com port  other than COM1,  you will need to
  104.          change the  GATE1  directive  to one suitable for your needs.
  105.          Again, I would recommend using the third version of this file
  106.          for your GTLOGON.BAT file.
  107.  
  108.          In  'door'  mode,  BGTOP does not create a bulletin.  It will
  109.          display an  ANSI  and  ASCII  version of  the top user report
  110.          depending upon the  ANSI  setting in the GTUSER.BBS file.  It
  111.          also fetches the current caller name from that  file  as well
  112.          and displays a special box letting the current caller see how
  113.          he or she stands up to the rest of the crowd on your board.
  114.  
  115.          -------------------------------------------------------------
  116.          OPTIONS
  117.          -------------------------------------------------------------
  118.   
  119.          Remember the command line options listed a long time ago?
  120.  
  121.             bgtop bulletin|door [/ln:number] [/ex:access_levels] [/nf]
  122.  
  123.          When BGTOP creates its informative bulletin,  it will display
  124.          the 15 top users (13 in 'door' mode).   If you wish to change
  125.          this default so that more (or less) users are shown, the /LN:
  126.          option is for you.  Example:
  127.  
  128.             bgtop 4 /ln:25
  129.  
  130.          The above  commands would cause  BGTOP  to  create bulletin 4
  131.          listing the 25 top users rather than the 15 top users.
  132.  
  133.          BGTOP will scan through all users in the USER.CTL file except
  134.          for any which have been  deleted  or  banned from your board.
  135.          You may also 'exclude' certain access levels from the report.
  136.          This is  useful  if you have special friends that wish not to
  137.          be listed on the report.  Example:
  138.  
  139.             bgtop 4 /ex:zW0
  140.  
  141.          The above syntax would cause  BGTOP  to ignore any user  that
  142.          has an access level of 'z', 'W', or '0'.  Please remember the
  143.          case of the access level is  very  important.   An upper case
  144.          'Z' is completly different from a lower case 'z'.  Ther is no
  145.          limit to the number of access levels that may be excluded.
  146.  
  147.          When  BGTOP  creates its reports, it pads all user names with
  148.          a string of periods.  The  string  of  periods is annoying to
  149.          some sysops and the  /NF  parameter  is provided to ease your
  150.          eyes.   If the  /NF  parameter is used,  BGTOP  will pad user
  151.          names with a string of blank spaces.
  152.  
  153.          All optional parameters can be used at the same time, e.g.
  154.  
  155.             bgtop 7 /ex:0bGF /nf /ln:20
  156.  
  157.          BGTOP would create a bulletin  7  composed of the twenty  top
  158.          users from your  board  excluding  those users  that  have an
  159.          acces level of '0', 'b', 'G', or 'F'.   And,  of course,  the
  160.          user names would be padded with blank spaces.
  161.  
  162.          -------------------------------------------------------------
  163.          ACKNOWLEDGEMENTS
  164.          -------------------------------------------------------------
  165.  
  166.          I  would  like  to  thank  the  following  people  for  their
  167.          assistance  with   bug  reports  and  implementation  of  new
  168.          command parameters ...  BGTOP 1.0 through BGTOP 1.9.  Thanks!
  169.  
  170.          Dennis Bills        Chuck Blair         Ed Bragg
  171.          Mel Douglass        Jim Kreyling        Chris Leaver
  172.          Bob Luzier          Scott Morris        April Strong
  173.          Dan Turkisher       Raymond Wood        Cory Wright
  174.  
  175.          The following people have given me suggestions for BGTOP 2.0.
  176.  
  177.          John Fisher         Tom Hamlyn          Russell Kroll
  178.  
  179.          The direct screen writes method used in  BGTOP 1.7 and beyond
  180.          where developed by Marshall Brain.
  181.  
  182.          I will also give special thanks to  Bob Camp  who helped some
  183.          solve  some of the  compatiblity  problems  and  gave me some
  184.          pointers on how to write code in  Turbo Pascal.   He actually
  185.          wrote  a portion of the new code in BGTOP 1.6.   Thanks, Bob!
  186.  
  187.          Russell suggested the current user block during 'door'  mode.
  188.  
  189.          -------------------------------------------------------------
  190.          OTHER INFORMATION
  191.          -------------------------------------------------------------
  192.  
  193.          The program has been  recompiled under  Turbo Pascal 5.5  and
  194.          was originally written in Quick Basic 4.5.  This is the  most
  195.          widely used BG companion program on the face of the Earth.
  196.  
  197.          This program is  FREEWARE.  No  registration fee  is required
  198.          for using this program,  BUT,  if  you  would  like to make a
  199.          contribution, I  won't  stop you!  Please  do  not  alter  or
  200.          reverse engineer this program in any way.
  201.  
  202.          If you have any suggestions or comments please  address  them
  203.          to  me via netmail or any appropriate echomail conference, or
  204.          via a direct voice or BBS phone call.
  205.  
  206.          <Plug> Check out the newest BG companion program,  BGQWK.  It
  207.          is the first QWK mail door for the GT Power family.  You will
  208.          love this thing.  It's shareware.  <Plug> Leap into RIME, the
  209.          RelayNet International Message Exchange Network with BGUTI.
  210.  
  211.          Regards,                                         GT:  001/040
  212.          B.J. Guillot                                   RIME: TRANQUIL
  213.